Skip to content

bugfix: missing fields in doc when using --log_samples #731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

VincentYCYao
Copy link
Contributor

@VincentYCYao VincentYCYao commented Jun 27, 2025

Issue: #712 (comment)

Bug ❓: Fields with "image" in keys or of type dict are not saved in the sample log file.

Fix: save dicts and all fields to the JSONL file

Testing: The update code has been tested with image-text-to-text inference. All fields including dicts in doc are saved in the log file.

Summary by CodeRabbit

  • Bug Fixes
    • All key-value pairs in evaluation samples are now saved without exclusion, ensuring that previously filtered data (such as images and audio arrays) are retained in the results.

Bug: Fields with "image" in keys or of type dict are not saved in the sample log file.

Fix: save dicts and all fields to the  JSONL file
Copy link
Contributor

coderabbitai bot commented Jun 27, 2025

Warning

Rate limit exceeded

@Luodian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 39 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b889c97 and bb53463.

📒 Files selected for processing (1)
  • lmms_eval/tasks/camerabench_vqa/utils.py (1 hunks)

Walkthrough

The update modifies the internal logic of the evaluate function in lmms_eval/evaluator.py by removing filters that previously excluded keys containing "image" and dictionary values with the key "array" from being saved. Now, all key-value pairs from the document are copied into saved_doc without restriction.

Changes

File(s) Change Summary
lmms_eval/evaluator.py Removed conditional filtering; all document key-value pairs are saved.

Poem

In the warren of code, a filter once stood,
Excluding some keys, as only it could.
Now every value, both small and grand,
Joins the saved_doc, by gentle command.
A hop of inclusion, no keys left behind—
The rabbit approves, with a peace of mind!

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Collaborator

@kcz358 kcz358 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we add this hardcoded logic because we don't want to save these large content (image, audio) into the the jsonl files for faster processing logic

@VincentYCYao
Copy link
Contributor Author

The reason to keep these fields with "image" is that people may have "image_size", "image_description", or "image":[dict] in the doc that will be used for metric calculation.

Note that dictionary is not saved in the current latest version.

@kcz358
Copy link
Collaborator

kcz358 commented Jul 7, 2025

I think in the later code

example = {
"doc_id": doc_id,
"doc": saved_doc,
"target": target,
"arguments": filtered_arguments,
"resps": [req.resps for req in requests],
"filtered_resps": [req.filtered_resps[filter_key] for req in requests],
"doc_hash": hash_string(
json.dumps(
requests[0].doc,
indent=2,
default=handle_non_serializable,
ensure_ascii=False,
)
),
"prompt_hash": hash_string(requests[0].arguments[0]),
"target_hash": hash_string(str(target)),

the saved doc will be added to the examples and will be added to the save doc when log samples is being used?

May I ask where will this being used for metric calculation? I think the save doc is after the process result step.

@YongchengYAO
Copy link

Yes, the structure of the log file is like this:

example = {
                        "doc_id": doc_id,
                        "doc": saved_doc,
                        "target": target,
                        "arguments": filtered_arguments,
                        "resps": [req.resps for req in requests],
                        "filtered_resps": [req.filtered_resps[filter_key] for req in requests],
                        "doc_hash": hash_string(
                            json.dumps(
                                requests[0].doc,
                                indent=2,
                                default=handle_non_serializable,
                                ensure_ascii=False,
                            )
                        ),
                        "prompt_hash": hash_string(requests[0].arguments[0]),
                        "target_hash": hash_string(str(target)),
                    }

where saved_doc contains the original info returned from a HF dataset. For instance, there would be {"doc": [RAW-doc-dict]} in the log file, where could be like {"image_path": [some path], "image_metainfo": [some info], "key w/o the string image": [sth]}.

The problem is that we are filtering the [RAW-doc-dict>] such that fields like "image_path" and "image_metainfo" are not saved in the log file. For example, if I have a custom HF dataset with complicated data structure and it comes with a data loading script (in HF dataset repo) that downloads the image data and returns the "image_path" when loaded with load_dataset(), the "image_path" is used to locate the image files.

Why it is desirable to keep the integrity of the raw doc info?

  • People may want to find (or plot) the corresponding image for debugging purposes or to investigate model failure mode.
  • Runing a model inference is expensive especially for a large dataset. And the model evaluation metrics are not always perfect when running the evaluation script. It is very likely that users may want to parse the model prediction after running the evaluation using additional post-processing script. In that case, some values in [RAW-doc-dict] could be useful for metric calculation.

@kcz358
Copy link
Collaborator

kcz358 commented Jul 11, 2025

The concern here is that in many many datasets currently integrated by lmms-eval, even the text part of the previous saved doc contains lots of content. When we performing evaluation, the saved doc would causing the saving results to be extreme slow and requires 200+ Mb to store the file. I would suggest this to be an optional choice to save full doc instead of hardcode it here

@YongchengYAO
Copy link

I agree. It would be nice to have an argument controling this behavior and increase the transparency of this process. In my case, I discovered this issue after a few runs.

Thank you very much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants